feat: auto-generate configuration from source code #518
Conversation
✅ Deploy Preview for biomejs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Aren't "drawback" and "con" the same thing? 😄 I would prefer keeping the options and examples together so I don't have to jump back and forth across pages. And the preview link further determined my thought. So it seems richer markdown doc comments the way to go. But I get the impression that |
That's how damanged my brain is 😆
Yeah, that's what the original PR attempts to do, and I don't mind moving better docs and examples in the source code.
I don't think we need |
| Ok(()) | ||
| } | ||
|
|
||
| fn generate_markdown_hearer() -> String { |
There was a problem hiding this comment.
i noticed a typo in my original function name... 🙏 It should be generate_markdown_header() and sorry for the mistake.
Oh yes, I was wrong. |
Summary
This is my attempt to create the configuration reference page from source code.
The drawback: we lose many examples
The con: we keep one source of truth
I see two options here:
What do you think?
Note
The source code is still junk and needs some polish. For now I would like feedback on what we would like to do and how